Skip to content

Replace deprecated rgb_order with channel_colors - #74

Merged
bharvey88 merged 3 commits into
betafrom
channel-colors-migration
Aug 30, 2026
Merged

Replace deprecated rgb_order with channel_colors#74
bharvey88 merged 3 commits into
betafrom
channel-colors-migration

Conversation

@TrevorSchirmer

@TrevorSchirmer TrevorSchirmer commented Aug 28, 2026

Copy link
Copy Markdown
Member

ESPHome 2026.8.0 replaces rgb_order / is_rgbw / is_wrgb with a single channel_colors key on esp32_rmt_led_strip (esphome#18474).

channel_colors takes each of R, G, B exactly once, optionally with a single W; the value is case-insensitive. No behaviour change — grb and GRB are equivalent, uppercase to match the ESPHome docs.

Summary by CodeRabbit

  • Bug Fixes
    • Updated RGB LED strip color channel configuration to ensure colors display in the correct order.
  • Compatibility
    • Updated ESPHome integration requirements to support ESPHome 2026.8.0 and later across supported configurations.
    • Updated the reported integration version to 26.8.27.1.

ESPHome 2026.8.0 replaces rgb_order/is_rgbw/is_wrgb with a single
channel_colors key on esp32_rmt_led_strip (esphome#18474).
@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 63ecafeb-de0f-484e-b31b-80dbb657fc33

📥 Commits

Reviewing files that changed from the base of the PR and between e50fb01 and 4949f90.

📒 Files selected for processing (7)
  • Integrations/ESPHome/Core.yaml
  • Integrations/ESPHome/PLT-1.yaml
  • Integrations/ESPHome/PLT-1B.yaml
  • Integrations/ESPHome/PLT-1B_BLE.yaml
  • Integrations/ESPHome/PLT-1B_Minimal.yaml
  • Integrations/ESPHome/PLT-1_BLE.yaml
  • Integrations/ESPHome/PLT-1_Minimal.yaml
🚧 Files skipped from review as they are similar to previous changes (1)
  • Integrations/ESPHome/Core.yaml

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


Walkthrough

The ESPHome configurations now require ESPHome 2026.8.0. The Core configuration updates its version substitution and replaces rgb_order: grb with channel_colors: GRB.

Changes

ESPHome configuration updates

Layer / File(s) Summary
Update ESPHome version requirements
Integrations/ESPHome/PLT-1*.yaml
Six PLT configurations now require ESPHome 2026.8.0 instead of 2025.6.0.
Update LED channel order
Integrations/ESPHome/Core.yaml
The configuration version changes to 26.8.27.1. The LED strip uses channel_colors: GRB instead of rgb_order: grb.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 4949f

This updates the ESPHome configuration to the current channel-color format and required version without changing intended LED behavior. No actionable merge-blocking risk remains beyond normal checks and review.

Suggested reviewers: bharvey88

Poem

A rabbit updates versions with care
GRB channels now match the declaration there
Old settings leave the YAML file
New requirements line up in style
The configs hop forward one mile

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the primary configuration change: replacing deprecated rgb_order with channel_colors. The version updates and related option changes are supporting details.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (7 skipped: 7 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch channel-colors-migration

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Bunton33 and others added 2 commits August 27, 2026 23:36
`channel_colors` only exists from ESPHome 2026.8.0 (esphome#18474), but
these YAMLs still declared an older min_version. Devices adopted through
the ESPHome dashboard track this repo at HEAD with no pinned ref, so on
an older ESPHome the next recompile fails with "Unknown option
channel_colors" pointing into a file the user never wrote, instead of a
clear version error.

ESPHome merges remote packages and checks min_version in the preload
phase, before component schemas load, so the bump produces the right
message. No firmware change: min_version is validation-only and emits no
code, so the compiled binary is unaffected.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@bharvey88 bharvey88 added the bugfix Bug fix label Aug 30, 2026

@bharvey88 bharvey88 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified against upstream rather than the description: channel_colors landed in ESPHome 2026.8.0 (esphome#18474), and rgb_order still validates but is marked for removal in 2027.3.0. validate_channel_colors uppercases its input and channel_colors_struct derives the same r/g/b indices, so GRB here is byte-identical to the previous grb. No behaviour change and no change to the compiled binary.

Every esp32_rmt_led_strip block in this repo is covered. I pushed one commit on top bumping min_version to 2026.8.0: devices adopted through the ESPHome dashboard track this repo at HEAD with no pinned ref, so without it an adopter on an older ESPHome would hit Unknown option channel_colors inside a file they never wrote. ESPHome merges remote packages and checks min_version before component schemas load, so the bump surfaces the right error instead.

CI green on stable, beta and dev.

@bharvey88
bharvey88 merged commit aed022d into beta Aug 30, 2026
19 checks passed
@bharvey88
bharvey88 deleted the channel-colors-migration branch August 30, 2026 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugfix Bug fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants